home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Aminet 50
/
Aminet 50 (2002)(GTI - Schatztruhe)[!][Aug 2002].iso
/
Aminet
/
util
/
cli
/
AKCC.lha
/
Programmers
/
Docs
/
akccplus.doc
next >
Wrap
Text File
|
2002-06-27
|
13KB
|
644 lines
Here is a listing of all currently available functions of the
akcc_gen0.library in an Autodoc-like style of description :
AKCC_StoreFile
AKCC_GetDate
AKCC_WildCmp
AKCC_Paths
AKCC_CopyFile
AKCC_TestEntry
AKCC_BStrCpy
AKCC_GetName
AKCC_FPrintf
AKCC_DelEnv
AKCC_ReadEnv
AKCC_WriteEnv
AKCC_Assign
AKCC_UnLineStr
AKCC_AddPathLock
AKCC_AddPathName
AKCC_RemPathName
AKCC_ParseText
AKCC_CheckAvailDevice
AKCC_SetDate
-----------------------------------------------------------------------------
Functions available since Version 37 :
-----------------------------------------------------------------------------
NAME
AKCC_StoreFile
SYNOPSIS
BYTE *AKCC_StoreFile(UBYTE *name, ULONG *bytes)
A1 A2
FUNCTION
Loads a file into a buffer.
Returns a pointer to the buffer or NULL.
BufferSize is stored in "bytes".
INPUT(S)
name - FilePath
bytes - Pointer to ULONG
RESULT
Buffer, which contains the whole File or NULL.
Has to be freed via FreeMem() after use if non-NULL.
SEE ALSO
AKCC_CopyFile
-----------------------------------------------------------------------------
NAME
AKCC_GetDate
SYNOPSIS
struct DateStruct *AKCC_GetDate(struct DateStamp *dos_rawdate)
A1
FUNCTION
Converts a DOS DateStamp structure into a more common,
human readable, format.
Returns a pointer to a structure or NULL.
INPUT(S)
dos_rawdate - Pointer to DateStamp-Struktur
RESULT
Pointer to DateStruct or NULL.
Has to be freed via FreeMem() after use if non-NULL.
SEE ALSO
DOS' date-functions
-----------------------------------------------------------------------------
NAME
AKCC_WildCmp
SYNOPSIS
long AKCC_WildCmp(UBYTE *orig, UBYTE *wild)
A1 A2
FUNCTION
Performs a WildCard comparion between a wildcard-string (wild)
and a usual string, which does not contain any wildcards (orig).
INPUT(S)
orig - non-wildcard string to compare
wird - wildcard-string for comparison
RESULT
TRUE for "wildcard matches",
FALSE for "wildcard does not match" (or error).
SEE ALSO
-
-----------------------------------------------------------------------------
NAME
AKCC_Paths
SYNOPSIS
long AKCC_Paths(UBYTE *name, UBYTE *rootdir, UBYTE *dir, UBYTE *comp)
A1 A2 A3 A4
FUNCTION
Splits a Dir(File)Path into two (three) parts :
- rootdir : RootDirPath (without "/", but with ":", if Device)
- dir : DirPath (with "/", if no Device)
- comp : FileName (may contain WildCards)
INPUT(S)
name - path to split
rootdir - Pointer to buffer for RootDirPath
dir - Pointer to buffer for DirPath
comp - Pointer to buffer for FileName
RESULT
TRUE for "was a DirPath",
FALSE for "was a FilePath".
Do not use this value for any plausibility checks on Files/Dirs.
It may be wrong for your purposes.
SEE ALSO
-
-----------------------------------------------------------------------------
NAME
AKCC_CopyFile
SYNOPSIS
long AKCC_CopyFile(UBYTE *sourcename, UBYTE *destname)
A1 A2
FUNCTION
Copies a file (sourcename) to an other (destname).
Buffer allocation and delocation is done auto- and dynamically.
INPUT(S)
sourcename - Name of SourceFile
destname - Name of DestFile
RESULT
TRUE for "action succesful",
FALSE for "error occured".
SEE ALSO
AKCC_StoreFile
-----------------------------------------------------------------------------
NAME
AKCC_TestEntry
SYNOPSIS
long AKCC_TestEntry(UBYTE *entryname)
A1
FUNCTION
Make some "trial-and-error" assumptions about the given
"entryname" to find out, whether it's a File, Dir or
virtual (!) Device (e.g. "CON").
Does some Open() and Lock() calls to decide this logically.
INPUT(S)
entryname - Name of the "objektes"
RESULT
Special code, descrbing the "object" (see Includes)
SEE ALSO
-
-----------------------------------------------------------------------------
NAME
AKCC_BStrCpy
SYNOPSIS
void AKCC_BStrCpy(UBYTE *dest, UBYTE *bstr, UBYTE *hangon)
A1 A2 A3
FUNCTION
Copies a BCPL-String to a C-String and concatenates "hangon"
to it (if non-NULL).
This is e.g. useful to create a Device-Name from a
BSTR ( BSTR: "DF0" -> C-STR: "DF0:").
INPUT(S)
dest - Pointer to string buffer
bstr - Pointer to BCPL-String
hangon - Pointer to string or NULL.
RESULT
-
SEE ALSO
-
-----------------------------------------------------------------------------
NAME
AKCC_GetName
SYNOPSIS
void AKCC_GetName(BPTR dest, BPTR fl, UBYTE *name)
A1 A2 A3
FUNCTION
Get full Path of a File/Dir from a Lock (BPTR).
The _same_ lock has to be passed twice (one copy is used as
a break condition for this recursive called function).
INPUT(S)
dest - File/Dir Lock (BPTR)
fl - same as dest
name - string buffer for the resulting path
(at least 256 Bytes)
RESULT
-
SEE ALSO
-
-----------------------------------------------------------------------------
NAME
AKCC_FPrintf
SYNOPSIS
void AKCC_FPrintf(BPTR outhandle, UBYTE *text, APTR pararr)
A1 A2 A3
FUNCTION
Similar to "printf()", but uses RawDoFmt() to perform the output.
Parameters have to be passed in an ULONG array (remember to
specify "%lc" instead of "%c", etc.).
The resulting string is written to outhandle (e.g. Output()).
INPUT(S)
outhandle - DosHandle for write-accesses
text - format string (printf)
pararr - array of args for format string
RESULT
-
SEE ALSO
AKCC_ParseText
-----------------------------------------------------------------------------
NAME
AKCC_DelEnv
SYNOPSIS
long AKCC_DelEnv(UBYTE *var)
A1
FUNCTION
Deletes an ENV-Variable.
INPUT(S)
var - variable name
RESULT
Boolean.
SEE ALSO
AKCC_ReadEnv, AKCC_WriteEnv
-----------------------------------------------------------------------------
NAME
AKCC_ReadEnv
SYNOPSIS
long AKCC_ReadEnv(UBYTE *var, UBYTE *content)
A1 A2
FUNCTION
Reads an ENV-Variable to a buffer.
INPUT(S)
var - variable name
content - buffer for content of variable
RESULT
Boolean.
SEE ALSO
AKCC_DelEnv, AKCC_WriteEnv
-----------------------------------------------------------------------------
NAME
AKCC_WriteEnv
SYNOPSIS
long AKCC_WriteEnv(UBYTE *var, UBYTE *content)
A1 A2
FUNCTION
Writes/Creates an ENV-Variable from a buffer.
INPUT(S)
var - variable name
content - content of variableü
RESULT
Boolean.
SEE ALSO
AKCC_DelEnv, AKCC_ReadEnv
-----------------------------------------------------------------------------
NAME
AKCC_Assign
SYNOPSIS
long AKCC_Assign(UBYTE *ass_name, UBYTE *ass_path)
A1 A2
FUNCTION
Assigns "ass_name" (e.g. "SYS:") to ass_path (e.g. "DF0:"
or "DF0:Sys".
Assigns to Files are legal and possible.
INPUT(S)
ass_name - AssignName (ended with ":")
ass_path - AssignPath
RESULT
Boolean.
SEE ALSO
-
-----------------------------------------------------------------------------
NAME
AKCC_UnLineStr
SYNOPSIS
void AKCC_UnLineStr(UBYTE *dest, UBYTE *source)
A1 A2
FUNCTION
Removes any controlcodes (return, linefeed, etc)
from a string to minimize side-effects, when displaying it.
INPUT(S)
dest - destination buffer
source - source string
RESULT
-
SEE ALSO
-
-----------------------------------------------------------------------------
NAME
AKCC_AddPathLock
SYNOPSIS
long AKCC_AddPathLock(BPTR lock)
A1
FUNCTION
Adds a new Path to the search-list of the CLI/Shell.
Uses a Lock as source.
INPUT(S)
lock - lock to a directory
RESULT
Boolean.
WARNING
Be careful using this function under OS V36.
Read the Includes for more information.
SEE ALSO
AKCC_AddPathName, AKCC_RemPathName, AKCC_GetName
-----------------------------------------------------------------------------
NAME
AKCC_AddPathName
SYNOPSIS
long AKCC_AddPathName(UBYTE *name)
A1
FUNCTION
Adds a new Path to the search-list of the CLI/Shell.
Uses a PathName as source.
INPUT(S)
name - PathName
RESULT
Boolean.
WARNING
Be careful using this function under OS V36.
Read the Includes for more information.
SEE ALSO
AKCC_AddPathLock, AKCC_RemPathName
-----------------------------------------------------------------------------
NAME
AKCC_RemPathName
SYNOPSIS
long AKCC_RemPathName(UBYTE *name)
A1
FUNCTION
Removes a Path from the search-list of the CLI/Shell.
Uses a PathName as source.
INPUT(S)
name - PathName
RESULT
Boolean.
WARNING
Be careful using this function under OS V36.
Read the Includes for more information.
SEE ALSO
AKCC_AddPathName, AKCC_AddPathLock
-----------------------------------------------------------------------------
NAME
AKCC_ParseText
SYNOPSIS
void AKCC_ParseText(UBYTE *orig, UBYTE *new)
A1 A2
FUNCTION
Parses a string, which may contain many special control-codes.
Output may e.g. be printed by AKCC_FPrintf() or any other
output function.
INPUT(S)
orig - formatted text (see Includes for details)
new - resulting output string
(controlcodes replaced by their "content")
RESULT
-
SEE ALSO
AKCC_FPrintf, C-Ausgabe-functionen, DOS-Ausgabe-functionen
-----------------------------------------------------------------------------
NAME
AKCC_CheckAvailDevice
SYNOPSIS
long AKCC_CheckAvailDevice(UBYTE *dev_name)
A1
FUNCTION
Checks, if a special Device (e.g. "PRT:", "NEWCON:")
is available, without trying to actually open it.
This only works for Devices (no Volumes or Dirs).
NO REQUESTER WILL APPEAR, if the Device is NOT AVAILABLE !
(Dos-Lists are read and checked.)
INPUT(S)
dev_name - DeviceName
RESULT
Boolean.
SEE ALSO
AKCC_Assign
-----------------------------------------------------------------------------
NAME
AKCC_SetDate
SYNOPSIS
long AKCC_SetDate(struct DateStruct *gd_date)
A1
FUNCTION
Resets the internal CIA-Timers to reflect the Date, which
is passed in "gd_date".
The RealTimeClock is NOT set (too may derivates).
INPUT(S)
gd_date - DateStruct pointer (e.g. returned by AKCC_GetDate())
RESULT
-
SEE ALSO
AKCC_GetDate
-----------------------------------------------------------------------------